home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / python2.5 / inspect.pyc (.txt) < prev    next >
Python Compiled Bytecode  |  2008-10-29  |  34KB  |  994 lines

  1. # Source Generated with Decompyle++
  2. # File: in.pyc (Python 2.5)
  3.  
  4. """Get useful information from live Python objects.
  5.  
  6. This module encapsulates the interface provided by the internal special
  7. attributes (func_*, co_*, im_*, tb_*, etc.) in a friendlier fashion.
  8. It also provides some help for examining source code and class layout.
  9.  
  10. Here are some of the useful functions provided by this module:
  11.  
  12.     ismodule(), isclass(), ismethod(), isfunction(), istraceback(),
  13.         isframe(), iscode(), isbuiltin(), isroutine() - check object types
  14.     getmembers() - get members of an object that satisfy a given condition
  15.  
  16.     getfile(), getsourcefile(), getsource() - find an object's source code
  17.     getdoc(), getcomments() - get documentation on an object
  18.     getmodule() - determine the module that an object came from
  19.     getclasstree() - arrange classes so as to represent their hierarchy
  20.  
  21.     getargspec(), getargvalues() - get info about function arguments
  22.     formatargspec(), formatargvalues() - format an argument spec
  23.     getouterframes(), getinnerframes() - get info about frames
  24.     currentframe() - get the current stack frame
  25.     stack(), trace() - get info about frames on the stack or in a traceback
  26. """
  27. __author__ = 'Ka-Ping Yee <ping@lfw.org>'
  28. __date__ = '1 Jan 2001'
  29. import sys
  30. import os
  31. import types
  32. import string
  33. import re
  34. import dis
  35. import imp
  36. import tokenize
  37. import linecache
  38. from operator import attrgetter
  39.  
  40. def ismodule(object):
  41.     '''Return true if the object is a module.
  42.  
  43.     Module objects provide these attributes:
  44.         __doc__         documentation string
  45.         __file__        filename (missing for built-in modules)'''
  46.     return isinstance(object, types.ModuleType)
  47.  
  48.  
  49. def isclass(object):
  50.     '''Return true if the object is a class.
  51.  
  52.     Class objects provide these attributes:
  53.         __doc__         documentation string
  54.         __module__      name of module in which this class was defined'''
  55.     if not isinstance(object, types.ClassType):
  56.         pass
  57.     return hasattr(object, '__bases__')
  58.  
  59.  
  60. def ismethod(object):
  61.     '''Return true if the object is an instance method.
  62.  
  63.     Instance method objects provide these attributes:
  64.         __doc__         documentation string
  65.         __name__        name with which this method was defined
  66.         im_class        class object in which this method belongs
  67.         im_func         function object containing implementation of method
  68.         im_self         instance to which this method is bound, or None'''
  69.     return isinstance(object, types.MethodType)
  70.  
  71.  
  72. def ismethoddescriptor(object):
  73.     '''Return true if the object is a method descriptor.
  74.  
  75.     But not if ismethod() or isclass() or isfunction() are true.
  76.  
  77.     This is new in Python 2.2, and, for example, is true of int.__add__.
  78.     An object passing this test has a __get__ attribute but not a __set__
  79.     attribute, but beyond that the set of attributes varies.  __name__ is
  80.     usually sensible, and __doc__ often is.
  81.  
  82.     Methods implemented via descriptors that also pass one of the other
  83.     tests return false from the ismethoddescriptor() test, simply because
  84.     the other tests promise more -- you can, e.g., count on having the
  85.     im_func attribute (etc) when an object passes ismethod().'''
  86.     if hasattr(object, '__get__') and not hasattr(object, '__set__') and not ismethod(object) and not isfunction(object):
  87.         pass
  88.     return not isclass(object)
  89.  
  90.  
  91. def isdatadescriptor(object):
  92.     '''Return true if the object is a data descriptor.
  93.  
  94.     Data descriptors have both a __get__ and a __set__ attribute.  Examples are
  95.     properties (defined in Python) and getsets and members (defined in C).
  96.     Typically, data descriptors will also have __name__ and __doc__ attributes
  97.     (properties, getsets, and members have both of these attributes), but this
  98.     is not guaranteed.'''
  99.     if hasattr(object, '__set__'):
  100.         pass
  101.     return hasattr(object, '__get__')
  102.  
  103. if hasattr(types, 'MemberDescriptorType'):
  104.     
  105.     def ismemberdescriptor(object):
  106.         '''Return true if the object is a member descriptor.
  107.  
  108.         Member descriptors are specialized descriptors defined in extension
  109.         modules.'''
  110.         return isinstance(object, types.MemberDescriptorType)
  111.  
  112. else:
  113.     
  114.     def ismemberdescriptor(object):
  115.         '''Return true if the object is a member descriptor.
  116.  
  117.         Member descriptors are specialized descriptors defined in extension
  118.         modules.'''
  119.         return False
  120.  
  121. if hasattr(types, 'GetSetDescriptorType'):
  122.     
  123.     def isgetsetdescriptor(object):
  124.         '''Return true if the object is a getset descriptor.
  125.  
  126.         getset descriptors are specialized descriptors defined in extension
  127.         modules.'''
  128.         return isinstance(object, types.GetSetDescriptorType)
  129.  
  130. else:
  131.     
  132.     def isgetsetdescriptor(object):
  133.         '''Return true if the object is a getset descriptor.
  134.  
  135.         getset descriptors are specialized descriptors defined in extension
  136.         modules.'''
  137.         return False
  138.  
  139.  
  140. def isfunction(object):
  141.     '''Return true if the object is a user-defined function.
  142.  
  143.     Function objects provide these attributes:
  144.         __doc__         documentation string
  145.         __name__        name with which this function was defined
  146.         func_code       code object containing compiled function bytecode
  147.         func_defaults   tuple of any default values for arguments
  148.         func_doc        (same as __doc__)
  149.         func_globals    global namespace in which this function was defined
  150.         func_name       (same as __name__)'''
  151.     return isinstance(object, types.FunctionType)
  152.  
  153.  
  154. def istraceback(object):
  155.     '''Return true if the object is a traceback.
  156.  
  157.     Traceback objects provide these attributes:
  158.         tb_frame        frame object at this level
  159.         tb_lasti        index of last attempted instruction in bytecode
  160.         tb_lineno       current line number in Python source code
  161.         tb_next         next inner traceback object (called by this level)'''
  162.     return isinstance(object, types.TracebackType)
  163.  
  164.  
  165. def isframe(object):
  166.     """Return true if the object is a frame object.
  167.  
  168.     Frame objects provide these attributes:
  169.         f_back          next outer frame object (this frame's caller)
  170.         f_builtins      built-in namespace seen by this frame
  171.         f_code          code object being executed in this frame
  172.         f_exc_traceback traceback if raised in this frame, or None
  173.         f_exc_type      exception type if raised in this frame, or None
  174.         f_exc_value     exception value if raised in this frame, or None
  175.         f_globals       global namespace seen by this frame
  176.         f_lasti         index of last attempted instruction in bytecode
  177.         f_lineno        current line number in Python source code
  178.         f_locals        local namespace seen by this frame
  179.         f_restricted    0 or 1 if frame is in restricted execution mode
  180.         f_trace         tracing function for this frame, or None"""
  181.     return isinstance(object, types.FrameType)
  182.  
  183.  
  184. def iscode(object):
  185.     '''Return true if the object is a code object.
  186.  
  187.     Code objects provide these attributes:
  188.         co_argcount     number of arguments (not including * or ** args)
  189.         co_code         string of raw compiled bytecode
  190.         co_consts       tuple of constants used in the bytecode
  191.         co_filename     name of file in which this code object was created
  192.         co_firstlineno  number of first line in Python source code
  193.         co_flags        bitmap: 1=optimized | 2=newlocals | 4=*arg | 8=**arg
  194.         co_lnotab       encoded mapping of line numbers to bytecode indices
  195.         co_name         name with which this code object was defined
  196.         co_names        tuple of names of local variables
  197.         co_nlocals      number of local variables
  198.         co_stacksize    virtual machine stack space required
  199.         co_varnames     tuple of names of arguments and local variables'''
  200.     return isinstance(object, types.CodeType)
  201.  
  202.  
  203. def isbuiltin(object):
  204.     '''Return true if the object is a built-in function or method.
  205.  
  206.     Built-in functions and methods provide these attributes:
  207.         __doc__         documentation string
  208.         __name__        original name of this function or method
  209.         __self__        instance to which a method is bound, or None'''
  210.     return isinstance(object, types.BuiltinFunctionType)
  211.  
  212.  
  213. def isroutine(object):
  214.     '''Return true if the object is any kind of function or method.'''
  215.     if not isbuiltin(object) and isfunction(object) and ismethod(object):
  216.         pass
  217.     return ismethoddescriptor(object)
  218.  
  219.  
  220. def getmembers(object, predicate = None):
  221.     '''Return all members of an object as (name, value) pairs sorted by name.
  222.     Optionally, only return members that satisfy a given predicate.'''
  223.     results = []
  224.     for key in dir(object):
  225.         value = getattr(object, key)
  226.         if not predicate or predicate(value):
  227.             results.append((key, value))
  228.             continue
  229.     
  230.     results.sort()
  231.     return results
  232.  
  233.  
  234. def classify_class_attrs(cls):
  235.     """Return list of attribute-descriptor tuples.
  236.  
  237.     For each name in dir(cls), the return list contains a 4-tuple
  238.     with these elements:
  239.  
  240.         0. The name (a string).
  241.  
  242.         1. The kind of attribute this is, one of these strings:
  243.                'class method'    created via classmethod()
  244.                'static method'   created via staticmethod()
  245.                'property'        created via property()
  246.                'method'          any other flavor of method
  247.                'data'            not a method
  248.  
  249.         2. The class which defined this attribute (a class).
  250.  
  251.         3. The object as obtained directly from the defining class's
  252.            __dict__, not via getattr.  This is especially important for
  253.            data attributes:  C.data is just a data object, but
  254.            C.__dict__['data'] may be a data descriptor with additional
  255.            info, like a __doc__ string.
  256.     """
  257.     mro = getmro(cls)
  258.     names = dir(cls)
  259.     result = []
  260.     for name in names:
  261.         if name in cls.__dict__:
  262.             obj = cls.__dict__[name]
  263.         else:
  264.             obj = getattr(cls, name)
  265.         homecls = getattr(obj, '__objclass__', None)
  266.         if homecls is None:
  267.             for base in mro:
  268.                 if name in base.__dict__:
  269.                     homecls = base
  270.                     break
  271.                     continue
  272.             
  273.         
  274.         if homecls is not None and name in homecls.__dict__:
  275.             obj = homecls.__dict__[name]
  276.         
  277.         obj_via_getattr = getattr(cls, name)
  278.         if isinstance(obj, staticmethod):
  279.             kind = 'static method'
  280.         elif isinstance(obj, classmethod):
  281.             kind = 'class method'
  282.         elif isinstance(obj, property):
  283.             kind = 'property'
  284.         elif ismethod(obj_via_getattr) or ismethoddescriptor(obj_via_getattr):
  285.             kind = 'method'
  286.         else:
  287.             kind = 'data'
  288.         result.append((name, kind, homecls, obj))
  289.     
  290.     return result
  291.  
  292.  
  293. def _searchbases(cls, accum):
  294.     if cls in accum:
  295.         return None
  296.     
  297.     accum.append(cls)
  298.     for base in cls.__bases__:
  299.         _searchbases(base, accum)
  300.     
  301.  
  302.  
  303. def getmro(cls):
  304.     '''Return tuple of base classes (including cls) in method resolution order.'''
  305.     if hasattr(cls, '__mro__'):
  306.         return cls.__mro__
  307.     else:
  308.         result = []
  309.         _searchbases(cls, result)
  310.         return tuple(result)
  311.  
  312.  
  313. def indentsize(line):
  314.     '''Return the indent size, in spaces, at the start of a line of text.'''
  315.     expline = string.expandtabs(line)
  316.     return len(expline) - len(string.lstrip(expline))
  317.  
  318.  
  319. def getdoc(object):
  320.     '''Get the documentation string for an object.
  321.  
  322.     All tabs are expanded to spaces.  To clean up docstrings that are
  323.     indented to line up with blocks of code, any whitespace than can be
  324.     uniformly removed from the second line onwards is removed.'''
  325.     
  326.     try:
  327.         doc = object.__doc__
  328.     except AttributeError:
  329.         return None
  330.  
  331.     if not isinstance(doc, types.StringTypes):
  332.         return None
  333.     
  334.     
  335.     try:
  336.         lines = string.split(string.expandtabs(doc), '\n')
  337.     except UnicodeError:
  338.         return None
  339.  
  340.     margin = sys.maxint
  341.     for line in lines[1:]:
  342.         content = len(string.lstrip(line))
  343.         if content:
  344.             indent = len(line) - content
  345.             margin = min(margin, indent)
  346.             continue
  347.     
  348.     if lines:
  349.         lines[0] = lines[0].lstrip()
  350.     
  351.     if margin < sys.maxint:
  352.         for i in range(1, len(lines)):
  353.             lines[i] = lines[i][margin:]
  354.         
  355.     
  356.     while lines and not lines[-1]:
  357.         lines.pop()
  358.     while lines and not lines[0]:
  359.         lines.pop(0)
  360.     return string.join(lines, '\n')
  361.  
  362.  
  363. def getfile(object):
  364.     '''Work out which source or compiled file an object was defined in.'''
  365.     if ismodule(object):
  366.         if hasattr(object, '__file__'):
  367.             return object.__file__
  368.         
  369.         raise TypeError('arg is a built-in module')
  370.     
  371.     if isclass(object):
  372.         object = sys.modules.get(object.__module__)
  373.         if hasattr(object, '__file__'):
  374.             return object.__file__
  375.         
  376.         raise TypeError('arg is a built-in class')
  377.     
  378.     if ismethod(object):
  379.         object = object.im_func
  380.     
  381.     if isfunction(object):
  382.         object = object.func_code
  383.     
  384.     if istraceback(object):
  385.         object = object.tb_frame
  386.     
  387.     if isframe(object):
  388.         object = object.f_code
  389.     
  390.     if iscode(object):
  391.         return object.co_filename
  392.     
  393.     raise TypeError('arg is not a module, class, method, function, traceback, frame, or code object')
  394.  
  395.  
  396. def getmoduleinfo(path):
  397.     '''Get the module name, suffix, mode, and module type for a given file.'''
  398.     filename = os.path.basename(path)
  399.     suffixes = map((lambda .0: (suffix, mode, mtype) = .0(-len(suffix), suffix, mode, mtype)), imp.get_suffixes())
  400.     suffixes.sort()
  401.     for neglen, suffix, mode, mtype in suffixes:
  402.         if filename[neglen:] == suffix:
  403.             return (filename[:neglen], suffix, mode, mtype)
  404.             continue
  405.     
  406.  
  407.  
  408. def getmodulename(path):
  409.     '''Return the module name for a given file, or None.'''
  410.     info = getmoduleinfo(path)
  411.     if info:
  412.         return info[0]
  413.     
  414.  
  415.  
  416. def getsourcefile(object):
  417.     '''Return the Python source file an object was defined in, if it exists.'''
  418.     filename = getfile(object)
  419.     if string.lower(filename[-4:]) in ('.pyc', '.pyo'):
  420.         filename = filename[:-4] + '.py'
  421.     
  422.     for suffix, mode, kind in imp.get_suffixes():
  423.         if 'b' in mode and string.lower(filename[-len(suffix):]) == suffix:
  424.             return None
  425.             continue
  426.     
  427.     if os.path.exists(filename):
  428.         return filename
  429.     
  430.     if hasattr(getmodule(object, filename), '__loader__'):
  431.         return filename
  432.     
  433.  
  434.  
  435. def getabsfile(object, _filename = None):
  436.     '''Return an absolute path to the source or compiled file for an object.
  437.  
  438.     The idea is for each object to have a unique origin, so this routine
  439.     normalizes the result as much as possible.'''
  440.     if _filename is None:
  441.         if not getsourcefile(object):
  442.             pass
  443.         _filename = getfile(object)
  444.     
  445.     return os.path.normcase(os.path.abspath(_filename))
  446.  
  447. modulesbyfile = { }
  448. _filesbymodname = { }
  449.  
  450. def getmodule(object, _filename = None):
  451.     '''Return the module an object was defined in, or None if not found.'''
  452.     if ismodule(object):
  453.         return object
  454.     
  455.     if hasattr(object, '__module__'):
  456.         return sys.modules.get(object.__module__)
  457.     
  458.     if _filename is not None and _filename in modulesbyfile:
  459.         return sys.modules.get(modulesbyfile[_filename])
  460.     
  461.     
  462.     try:
  463.         file = getabsfile(object, _filename)
  464.     except TypeError:
  465.         return None
  466.  
  467.     if file in modulesbyfile:
  468.         return sys.modules.get(modulesbyfile[file])
  469.     
  470.     for modname, module in sys.modules.items():
  471.         if ismodule(module) and hasattr(module, '__file__'):
  472.             f = module.__file__
  473.             if f == _filesbymodname.get(modname, None):
  474.                 continue
  475.             
  476.             _filesbymodname[modname] = f
  477.             f = getabsfile(module)
  478.             modulesbyfile[f] = modulesbyfile[os.path.realpath(f)] = module.__name__
  479.             continue
  480.     
  481.     if file in modulesbyfile:
  482.         return sys.modules.get(modulesbyfile[file])
  483.     
  484.     main = sys.modules['__main__']
  485.     if not hasattr(object, '__name__'):
  486.         return None
  487.     
  488.     if hasattr(main, object.__name__):
  489.         mainobject = getattr(main, object.__name__)
  490.         if mainobject is object:
  491.             return main
  492.         
  493.     
  494.     builtin = sys.modules['__builtin__']
  495.     if hasattr(builtin, object.__name__):
  496.         builtinobject = getattr(builtin, object.__name__)
  497.         if builtinobject is object:
  498.             return builtin
  499.         
  500.     
  501.  
  502.  
  503. def findsource(object):
  504.     '''Return the entire source file and starting line number for an object.
  505.  
  506.     The argument may be a module, class, method, function, traceback, frame,
  507.     or code object.  The source code is returned as a list of all the lines
  508.     in the file and the line number indexes a line in that list.  An IOError
  509.     is raised if the source code cannot be retrieved.'''
  510.     if not getsourcefile(object):
  511.         pass
  512.     file = getfile(object)
  513.     module = getmodule(object, file)
  514.     if module:
  515.         lines = linecache.getlines(file, module.__dict__)
  516.     else:
  517.         lines = linecache.getlines(file)
  518.     if not lines:
  519.         raise IOError('could not get source code')
  520.     
  521.     if ismodule(object):
  522.         return (lines, 0)
  523.     
  524.     if isclass(object):
  525.         name = object.__name__
  526.         pat = re.compile('^(\\s*)class\\s*' + name + '\\b')
  527.         candidates = []
  528.         for i in range(len(lines)):
  529.             match = pat.match(lines[i])
  530.             if match:
  531.                 if lines[i][0] == 'c':
  532.                     return (lines, i)
  533.                 
  534.                 candidates.append((match.group(1), i))
  535.                 continue
  536.         
  537.         if candidates:
  538.             candidates.sort()
  539.             return (lines, candidates[0][1])
  540.         else:
  541.             raise IOError('could not find class definition')
  542.     
  543.     if ismethod(object):
  544.         object = object.im_func
  545.     
  546.     if isfunction(object):
  547.         object = object.func_code
  548.     
  549.     if istraceback(object):
  550.         object = object.tb_frame
  551.     
  552.     if isframe(object):
  553.         object = object.f_code
  554.     
  555.     if iscode(object):
  556.         if not hasattr(object, 'co_firstlineno'):
  557.             raise IOError('could not find function definition')
  558.         
  559.         lnum = object.co_firstlineno - 1
  560.         pat = re.compile('^(\\s*def\\s)|(.*(?<!\\w)lambda(:|\\s))|^(\\s*@)')
  561.         while lnum > 0:
  562.             if pat.match(lines[lnum]):
  563.                 break
  564.             
  565.             lnum = lnum - 1
  566.         return (lines, lnum)
  567.     
  568.     raise IOError('could not find code object')
  569.  
  570.  
  571. def getcomments(object):
  572.     """Get lines of comments immediately preceding an object's source code.
  573.  
  574.     Returns None when source can't be found.
  575.     """
  576.     
  577.     try:
  578.         (lines, lnum) = findsource(object)
  579.     except (IOError, TypeError):
  580.         return None
  581.  
  582.     if ismodule(object):
  583.         start = 0
  584.         if lines and lines[0][:2] == '#!':
  585.             start = 1
  586.         
  587.         while start < len(lines) and string.strip(lines[start]) in ('', '#'):
  588.             start = start + 1
  589.         if start < len(lines) and lines[start][:1] == '#':
  590.             comments = []
  591.             end = start
  592.             while end < len(lines) and lines[end][:1] == '#':
  593.                 comments.append(string.expandtabs(lines[end]))
  594.                 end = end + 1
  595.             return string.join(comments, '')
  596.         
  597.     elif lnum > 0:
  598.         indent = indentsize(lines[lnum])
  599.         end = lnum - 1
  600.         if end >= 0 and string.lstrip(lines[end])[:1] == '#' and indentsize(lines[end]) == indent:
  601.             comments = [
  602.                 string.lstrip(string.expandtabs(lines[end]))]
  603.             if end > 0:
  604.                 end = end - 1
  605.                 comment = string.lstrip(string.expandtabs(lines[end]))
  606.                 while comment[:1] == '#' and indentsize(lines[end]) == indent:
  607.                     comments[:0] = [
  608.                         comment]
  609.                     end = end - 1
  610.                     if end < 0:
  611.                         break
  612.                     
  613.                     comment = string.lstrip(string.expandtabs(lines[end]))
  614.             
  615.             while comments and string.strip(comments[0]) == '#':
  616.                 comments[:1] = []
  617.             while comments and string.strip(comments[-1]) == '#':
  618.                 comments[-1:] = []
  619.             return string.join(comments, '')
  620.         
  621.     
  622.  
  623.  
  624. class EndOfBlock(Exception):
  625.     pass
  626.  
  627.  
  628. class BlockFinder:
  629.     '''Provide a tokeneater() method to detect the end of a code block.'''
  630.     
  631.     def __init__(self):
  632.         self.indent = 0
  633.         self.islambda = False
  634.         self.started = False
  635.         self.passline = False
  636.         self.last = 1
  637.  
  638.     
  639.     def tokeneater(self, type, token, .3, .4, line):
  640.         (srow, scol) = .3
  641.         (erow, ecol) = .4
  642.         if not self.started:
  643.             if token in ('def', 'class', 'lambda'):
  644.                 if token == 'lambda':
  645.                     self.islambda = True
  646.                 
  647.                 self.started = True
  648.             
  649.             self.passline = True
  650.         elif type == tokenize.NEWLINE:
  651.             self.passline = False
  652.             self.last = srow
  653.             if self.islambda:
  654.                 raise EndOfBlock
  655.             
  656.         elif self.passline:
  657.             pass
  658.         elif type == tokenize.INDENT:
  659.             self.indent = self.indent + 1
  660.             self.passline = True
  661.         elif type == tokenize.DEDENT:
  662.             self.indent = self.indent - 1
  663.             if self.indent <= 0:
  664.                 raise EndOfBlock
  665.             
  666.         elif self.indent == 0 and type not in (tokenize.COMMENT, tokenize.NL):
  667.             raise EndOfBlock
  668.         
  669.  
  670.  
  671.  
  672. def getblock(lines):
  673.     '''Extract the block of code at the top of the given list of lines.'''
  674.     blockfinder = BlockFinder()
  675.     
  676.     try:
  677.         tokenize.tokenize(iter(lines).next, blockfinder.tokeneater)
  678.     except (EndOfBlock, IndentationError):
  679.         pass
  680.  
  681.     return lines[:blockfinder.last]
  682.  
  683.  
  684. def getsourcelines(object):
  685.     '''Return a list of source lines and starting line number for an object.
  686.  
  687.     The argument may be a module, class, method, function, traceback, frame,
  688.     or code object.  The source code is returned as a list of the lines
  689.     corresponding to the object and the line number indicates where in the
  690.     original source file the first line of code was found.  An IOError is
  691.     raised if the source code cannot be retrieved.'''
  692.     (lines, lnum) = findsource(object)
  693.     if ismodule(object):
  694.         return (lines, 0)
  695.     else:
  696.         return (getblock(lines[lnum:]), lnum + 1)
  697.  
  698.  
  699. def getsource(object):
  700.     '''Return the text of the source code for an object.
  701.  
  702.     The argument may be a module, class, method, function, traceback, frame,
  703.     or code object.  The source code is returned as a single string.  An
  704.     IOError is raised if the source code cannot be retrieved.'''
  705.     (lines, lnum) = getsourcelines(object)
  706.     return string.join(lines, '')
  707.  
  708.  
  709. def walktree(classes, children, parent):
  710.     '''Recursive helper function for getclasstree().'''
  711.     results = []
  712.     classes.sort(key = attrgetter('__module__', '__name__'))
  713.     for c in classes:
  714.         results.append((c, c.__bases__))
  715.         if c in children:
  716.             results.append(walktree(children[c], children, c))
  717.             continue
  718.     
  719.     return results
  720.  
  721.  
  722. def getclasstree(classes, unique = 0):
  723.     """Arrange the given list of classes into a hierarchy of nested lists.
  724.  
  725.     Where a nested list appears, it contains classes derived from the class
  726.     whose entry immediately precedes the list.  Each entry is a 2-tuple
  727.     containing a class and a tuple of its base classes.  If the 'unique'
  728.     argument is true, exactly one entry appears in the returned structure
  729.     for each class in the given list.  Otherwise, classes using multiple
  730.     inheritance and their descendants will appear multiple times."""
  731.     children = { }
  732.     roots = []
  733.     for c in classes:
  734.         if c.__bases__:
  735.             for parent in c.__bases__:
  736.                 if parent not in children:
  737.                     children[parent] = []
  738.                 
  739.                 children[parent].append(c)
  740.                 if unique and parent in classes:
  741.                     break
  742.                     continue
  743.             
  744.         if c not in roots:
  745.             roots.append(c)
  746.             continue
  747.     
  748.     for parent in children:
  749.         if parent not in classes:
  750.             roots.append(parent)
  751.             continue
  752.     
  753.     return walktree(roots, children, None)
  754.  
  755. (CO_OPTIMIZED, CO_NEWLOCALS, CO_VARARGS, CO_VARKEYWORDS) = (1, 2, 4, 8)
  756.  
  757. def getargs(co):
  758.     """Get information about the arguments accepted by a code object.
  759.  
  760.     Three things are returned: (args, varargs, varkw), where 'args' is
  761.     a list of argument names (possibly containing nested lists), and
  762.     'varargs' and 'varkw' are the names of the * and ** arguments or None."""
  763.     if not iscode(co):
  764.         raise TypeError('arg is not a code object')
  765.     
  766.     nargs = co.co_argcount
  767.     names = co.co_varnames
  768.     args = list(names[:nargs])
  769.     step = 0
  770.     for i in range(nargs):
  771.         if args[i][:1] in ('', '.'):
  772.             stack = []
  773.             remain = []
  774.             count = []
  775.             while step < len(co.co_code):
  776.                 op = ord(co.co_code[step])
  777.                 step = step + 1
  778.                 if op >= dis.HAVE_ARGUMENT:
  779.                     opname = dis.opname[op]
  780.                     value = ord(co.co_code[step]) + ord(co.co_code[step + 1]) * 256
  781.                     step = step + 2
  782.                     if opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE'):
  783.                         remain.append(value)
  784.                         count.append(value)
  785.                     elif opname == 'STORE_FAST':
  786.                         stack.append(names[value])
  787.                         if not remain:
  788.                             stack[0] = [
  789.                                 stack[0]]
  790.                             break
  791.                         else:
  792.                             remain[-1] = remain[-1] - 1
  793.                             while remain[-1] == 0:
  794.                                 remain.pop()
  795.                                 size = count.pop()
  796.                                 stack[-size:] = [
  797.                                     stack[-size:]]
  798.                                 if not remain:
  799.                                     break
  800.                                 
  801.                                 remain[-1] = remain[-1] - 1
  802.                             if not remain:
  803.                                 break
  804.                             
  805.                     
  806.                 opname in ('UNPACK_TUPLE', 'UNPACK_SEQUENCE')
  807.             args[i] = stack[0]
  808.             continue
  809.     
  810.     varargs = None
  811.     if co.co_flags & CO_VARARGS:
  812.         varargs = co.co_varnames[nargs]
  813.         nargs = nargs + 1
  814.     
  815.     varkw = None
  816.     if co.co_flags & CO_VARKEYWORDS:
  817.         varkw = co.co_varnames[nargs]
  818.     
  819.     return (args, varargs, varkw)
  820.  
  821.  
  822. def getargspec(func):
  823.     """Get the names and default values of a function's arguments.
  824.  
  825.     A tuple of four things is returned: (args, varargs, varkw, defaults).
  826.     'args' is a list of the argument names (it may contain nested lists).
  827.     'varargs' and 'varkw' are the names of the * and ** arguments or None.
  828.     'defaults' is an n-tuple of the default values of the last n arguments.
  829.     """
  830.     if ismethod(func):
  831.         func = func.im_func
  832.     
  833.     if not isfunction(func):
  834.         raise TypeError('arg is not a Python function')
  835.     
  836.     (args, varargs, varkw) = getargs(func.func_code)
  837.     return (args, varargs, varkw, func.func_defaults)
  838.  
  839.  
  840. def getargvalues(frame):
  841.     """Get information about arguments passed into a particular frame.
  842.  
  843.     A tuple of four things is returned: (args, varargs, varkw, locals).
  844.     'args' is a list of the argument names (it may contain nested lists).
  845.     'varargs' and 'varkw' are the names of the * and ** arguments or None.
  846.     'locals' is the locals dictionary of the given frame."""
  847.     (args, varargs, varkw) = getargs(frame.f_code)
  848.     return (args, varargs, varkw, frame.f_locals)
  849.  
  850.  
  851. def joinseq(seq):
  852.     if len(seq) == 1:
  853.         return '(' + seq[0] + ',)'
  854.     else:
  855.         return '(' + string.join(seq, ', ') + ')'
  856.  
  857.  
  858. def strseq(object, convert, join = joinseq):
  859.     '''Recursively walk a sequence, stringifying each element.'''
  860.     if type(object) in (list, tuple):
  861.         return join(map((lambda o, c = convert, j = join: strseq(o, c, j)), object))
  862.     else:
  863.         return convert(object)
  864.  
  865.  
  866. def formatargspec(args, varargs = None, varkw = None, defaults = None, formatarg = str, formatvarargs = (lambda name: '*' + name), formatvarkw = (lambda name: '**' + name), formatvalue = (lambda value: '=' + repr(value)), join = joinseq):
  867.     '''Format an argument spec from the 4 values returned by getargspec.
  868.  
  869.     The first four arguments are (args, varargs, varkw, defaults).  The
  870.     other four arguments are the corresponding optional formatting functions
  871.     that are called to turn names and values into strings.  The ninth
  872.     argument is an optional function to format the sequence of arguments.'''
  873.     specs = []
  874.     if defaults:
  875.         firstdefault = len(args) - len(defaults)
  876.     
  877.     for i in range(len(args)):
  878.         spec = strseq(args[i], formatarg, join)
  879.         if defaults and i >= firstdefault:
  880.             spec = spec + formatvalue(defaults[i - firstdefault])
  881.         
  882.         specs.append(spec)
  883.     
  884.     if varargs is not None:
  885.         specs.append(formatvarargs(varargs))
  886.     
  887.     if varkw is not None:
  888.         specs.append(formatvarkw(varkw))
  889.     
  890.     return '(' + string.join(specs, ', ') + ')'
  891.  
  892.  
  893. def formatargvalues(args, varargs, varkw, locals, formatarg = str, formatvarargs = (lambda name: '*' + name), formatvarkw = (lambda name: '**' + name), formatvalue = (lambda value: '=' + repr(value)), join = joinseq):
  894.     '''Format an argument spec from the 4 values returned by getargvalues.
  895.  
  896.     The first four arguments are (args, varargs, varkw, locals).  The
  897.     next four arguments are the corresponding optional formatting functions
  898.     that are called to turn names and values into strings.  The ninth
  899.     argument is an optional function to format the sequence of arguments.'''
  900.     
  901.     def convert(name, locals = locals, formatarg = formatarg, formatvalue = formatvalue):
  902.         return formatarg(name) + formatvalue(locals[name])
  903.  
  904.     specs = []
  905.     for i in range(len(args)):
  906.         specs.append(strseq(args[i], convert, join))
  907.     
  908.     if varargs:
  909.         specs.append(formatvarargs(varargs) + formatvalue(locals[varargs]))
  910.     
  911.     if varkw:
  912.         specs.append(formatvarkw(varkw) + formatvalue(locals[varkw]))
  913.     
  914.     return '(' + string.join(specs, ', ') + ')'
  915.  
  916.  
  917. def getframeinfo(frame, context = 1):
  918.     '''Get information about a frame or traceback object.
  919.  
  920.     A tuple of five things is returned: the filename, the line number of
  921.     the current line, the function name, a list of lines of context from
  922.     the source code, and the index of the current line within that list.
  923.     The optional second argument specifies the number of lines of context
  924.     to return, which are centered around the current line.'''
  925.     if istraceback(frame):
  926.         lineno = frame.tb_lineno
  927.         frame = frame.tb_frame
  928.     else:
  929.         lineno = frame.f_lineno
  930.     if not isframe(frame):
  931.         raise TypeError('arg is not a frame or traceback object')
  932.     
  933.     if not getsourcefile(frame):
  934.         pass
  935.     filename = getfile(frame)
  936.     if context > 0:
  937.         start = lineno - 1 - context // 2
  938.         
  939.         try:
  940.             (lines, lnum) = findsource(frame)
  941.         except IOError:
  942.             lines = None
  943.             index = None
  944.  
  945.         start = max(start, 1)
  946.         start = max(0, min(start, len(lines) - context))
  947.         lines = lines[start:start + context]
  948.         index = lineno - 1 - start
  949.     else:
  950.         lines = None
  951.         index = None
  952.     return (filename, lineno, frame.f_code.co_name, lines, index)
  953.  
  954.  
  955. def getlineno(frame):
  956.     '''Get the line number from a frame object, allowing for optimization.'''
  957.     return frame.f_lineno
  958.  
  959.  
  960. def getouterframes(frame, context = 1):
  961.     '''Get a list of records for a frame and all higher (calling) frames.
  962.  
  963.     Each record contains a frame object, filename, line number, function
  964.     name, a list of lines of context, and index within the context.'''
  965.     framelist = []
  966.     while frame:
  967.         framelist.append((frame,) + getframeinfo(frame, context))
  968.         frame = frame.f_back
  969.     return framelist
  970.  
  971.  
  972. def getinnerframes(tb, context = 1):
  973.     """Get a list of records for a traceback's frame and all lower frames.
  974.  
  975.     Each record contains a frame object, filename, line number, function
  976.     name, a list of lines of context, and index within the context."""
  977.     framelist = []
  978.     while tb:
  979.         framelist.append((tb.tb_frame,) + getframeinfo(tb, context))
  980.         tb = tb.tb_next
  981.     return framelist
  982.  
  983. currentframe = sys._getframe
  984.  
  985. def stack(context = 1):
  986.     """Return a list of records for the stack above the caller's frame."""
  987.     return getouterframes(sys._getframe(1), context)
  988.  
  989.  
  990. def trace(context = 1):
  991.     '''Return a list of records for the stack below the current exception.'''
  992.     return getinnerframes(sys.exc_info()[2], context)
  993.  
  994.